<!-- HTML header for doxygen 1.8.13-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MTB CAT1 Peripheral driver library: Backup Domain</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen_style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><a href="http://www.cypress.com/"><img alt="Logo" src="IFXCYP_one-line.png"/></a></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">MTB CAT1 Peripheral driver library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__group__syspm__functions__backup.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Backup Domain<div class="ingroups"><a class="el" href="group__group__syspm.html">SysPm        (System Power Management)</a> &raquo; <a class="el" href="group__group__syspm__functions.html">Functions</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">General Description</h2>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gad6c5aa1ff07043550bf0e49e000e93cd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__backup.html#gad6c5aa1ff07043550bf0e49e000e93cd">Cy_SysPm_BackupSetSupply</a> (<a class="el" href="group__group__syspm__data__enumerates.html#ga07d01979fa53fd8a53203bf362a8add1">cy_en_syspm_vddbackup_control_t</a> vddBackControl)</td></tr>
<tr class="memdesc:gad6c5aa1ff07043550bf0e49e000e93cd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the backup supply (Vddback) operation mode.  <a href="#gad6c5aa1ff07043550bf0e49e000e93cd">More...</a><br /></td></tr>
<tr class="separator:gad6c5aa1ff07043550bf0e49e000e93cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9056ecea6aa1b86d3c657bd1692a92a8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__syspm__data__enumerates.html#ga07d01979fa53fd8a53203bf362a8add1">cy_en_syspm_vddbackup_control_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__backup.html#ga9056ecea6aa1b86d3c657bd1692a92a8">Cy_SysPm_BackupGetSupply</a> (void)</td></tr>
<tr class="memdesc:ga9056ecea6aa1b86d3c657bd1692a92a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current backup supply (Vddback) operation mode.  <a href="#ga9056ecea6aa1b86d3c657bd1692a92a8">More...</a><br /></td></tr>
<tr class="separator:ga9056ecea6aa1b86d3c657bd1692a92a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad87323df5ca65d861bcb67b03c7ee594"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__backup.html#gad87323df5ca65d861bcb67b03c7ee594">Cy_SysPm_BackupEnableVoltageMeasurement</a> (void)</td></tr>
<tr class="memdesc:gad87323df5ca65d861bcb67b03c7ee594"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function enables Vbackup supply measurement by the ADC.  <a href="#gad87323df5ca65d861bcb67b03c7ee594">More...</a><br /></td></tr>
<tr class="separator:gad87323df5ca65d861bcb67b03c7ee594"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2de08a3d7db223f4106d938843f5b846"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__backup.html#ga2de08a3d7db223f4106d938843f5b846">Cy_SysPm_BackupDisableVoltageMeasurement</a> (void)</td></tr>
<tr class="memdesc:ga2de08a3d7db223f4106d938843f5b846"><td class="mdescLeft">&#160;</td><td class="mdescRight">The function disables Vbackup supply measurement by the ADC by disconnecting the Vbackup supply from AMuxBusA.  <a href="#ga2de08a3d7db223f4106d938843f5b846">More...</a><br /></td></tr>
<tr class="separator:ga2de08a3d7db223f4106d938843f5b846"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8ec1e64a405842b4b5bd62a418dfad1f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__backup.html#ga8ec1e64a405842b4b5bd62a418dfad1f">Cy_SysPm_BackupSuperCapCharge</a> (<a class="el" href="group__group__syspm__data__enumerates.html#gaffbcaa784d215b003d6b95e0620b9fa7">cy_en_syspm_sc_charge_key_t</a> key)</td></tr>
<tr class="memdesc:ga8ec1e64a405842b4b5bd62a418dfad1f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures the supercapacitor charger circuit.  <a href="#ga8ec1e64a405842b4b5bd62a418dfad1f">More...</a><br /></td></tr>
<tr class="separator:ga8ec1e64a405842b4b5bd62a418dfad1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaaad0d60d7cd653e0651f6eb4e66ab02f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__backup.html#gaaad0d60d7cd653e0651f6eb4e66ab02f">Cy_SysPm_BackupWordStore</a> (uint32_t wordIndex, uint32_t *wordSrcPointer, uint32_t wordSize)</td></tr>
<tr class="memdesc:gaaad0d60d7cd653e0651f6eb4e66ab02f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stores supported number of words(SRSS_BACKUP_NUM_BREG) in Backup Domain.  <a href="#gaaad0d60d7cd653e0651f6eb4e66ab02f">More...</a><br /></td></tr>
<tr class="separator:gaaad0d60d7cd653e0651f6eb4e66ab02f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad101a96506a0ea0ef62f2a09af94be55"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__backup.html#gad101a96506a0ea0ef62f2a09af94be55">Cy_SysPm_BackupWordReStore</a> (uint32_t wordIndex, uint32_t *wordDstPointer, uint32_t wordSize)</td></tr>
<tr class="memdesc:gad101a96506a0ea0ef62f2a09af94be55"><td class="mdescLeft">&#160;</td><td class="mdescRight">Restores supported number of words(SRSS_BACKUP_NUM_BREG) in Backup Domain.  <a href="#gad101a96506a0ea0ef62f2a09af94be55">More...</a><br /></td></tr>
<tr class="separator:gad101a96506a0ea0ef62f2a09af94be55"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0d4a41fe70f20ca3ea7b2e78994004ae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__backup.html#ga0d4a41fe70f20ca3ea7b2e78994004ae">Cy_SysPm_SetupDeepSleepRAM</a> (<a class="el" href="group__group__syspm__data__enumerates.html#gacf9bb0bb5be207ed5e2e87d6c41dbb40">cy_en_syspm_dsram_checks_t</a> dsramCheck, uint32_t *dsramIntState)</td></tr>
<tr class="memdesc:ga0d4a41fe70f20ca3ea7b2e78994004ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Implements Pre and Post Deepsleep RAM Setup.  <a href="#ga0d4a41fe70f20ca3ea7b2e78994004ae">More...</a><br /></td></tr>
<tr class="separator:ga0d4a41fe70f20ca3ea7b2e78994004ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0ad6666907cdc8668196bc5e849cd7f1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__syspm__functions__backup.html#ga0ad6666907cdc8668196bc5e849cd7f1">Cy_SysPm_CpuEnterRAMOffDeepSleep</a> (void)</td></tr>
<tr class="memdesc:ga0ad6666907cdc8668196bc5e849cd7f1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets executing CPU to the Deep Sleep mode forceful RAM OFF.  <a href="#ga0ad6666907cdc8668196bc5e849cd7f1">More...</a><br /></td></tr>
<tr class="separator:ga0ad6666907cdc8668196bc5e849cd7f1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="gad6c5aa1ff07043550bf0e49e000e93cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad6c5aa1ff07043550bf0e49e000e93cd">&#9670;&nbsp;</a></span>Cy_SysPm_BackupSetSupply()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysPm_BackupSetSupply </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__syspm__data__enumerates.html#ga07d01979fa53fd8a53203bf362a8add1">cy_en_syspm_vddbackup_control_t</a>&#160;</td>
          <td class="paramname"><em>vddBackControl</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the backup supply (Vddback) operation mode. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">vddBackControl</td><td>Selects backup supply (Vddback) operation mode. See <a class="el" href="group__group__syspm__data__enumerates.html#ga07d01979fa53fd8a53203bf362a8add1">cy_en_syspm_vddbackup_control_t</a>.</td></tr>
  </table>
  </dd>
</dl>
<p>Refer to device TRM for more detail about backup supply modes. Will do nothing if device TRM denotes VDDBAK_CTL register field is unavailable.</p>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: There is a need to set only Vbackup to supply Vddbackup */</span></div><div class="line">    <span class="comment">/* Ensure there is a valid power connection on backup pin */</span></div><div class="line"><span class="preprocessor">#if defined (CY_IP_MXS40SSRSS) || (defined (CY_IP_MXS40SRSS) &amp;&amp; (CY_IP_MXS40SRSS_VERSION &gt;= 2) &amp;&amp; (defined (SRSS_BACKUP_VBCK_PRESENT) &amp;&amp; (SRSS_BACKUP_VBCK_PRESENT == 1u)))</span></div><div class="line">    <a class="code" href="group__group__syspm__functions__backup.html#gad6c5aa1ff07043550bf0e49e000e93cd">Cy_SysPm_BackupSetSupply</a>(<a class="code" href="group__group__syspm__data__enumerates.html#gga07d01979fa53fd8a53203bf362a8add1a92e63136dca5cbb468d5c756b29b96a0">CY_SYSPM_VDDBACKUP_VBACKUP</a>);</div><div class="line"><span class="preprocessor">#endif </span><span class="comment">/* defined (CY_IP_MXS40SSRSS) || (defined (CY_IP_MXS40SRSS) &amp;&amp; (CY_IP_MXS40SRSS_VERSION &gt;= 2) &amp;&amp; (defined (SRSS_BACKUP_VBCK_PRESENT) &amp;&amp; (SRSS_BACKUP_VBCK_PRESENT == 1u))) */</span><span class="preprocessor"></span></div></div><!-- fragment --></dd></dl>

</div>
</div>
<a id="ga9056ecea6aa1b86d3c657bd1692a92a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9056ecea6aa1b86d3c657bd1692a92a8">&#9670;&nbsp;</a></span>Cy_SysPm_BackupGetSupply()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__syspm__data__enumerates.html#ga07d01979fa53fd8a53203bf362a8add1">cy_en_syspm_vddbackup_control_t</a> Cy_SysPm_BackupGetSupply </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the current backup supply (Vddback) operation mode. </p>
<dl class="section return"><dt>Returns</dt><dd>The current backup supply (Vddback) operation mode, see <a class="el" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a>.</dd></dl>
<p>Refer to device TRM for more detail about backup supply modes.</p>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: There is a need to get the current backup supply (Vddback) operation mode */</span></div><div class="line"><span class="preprocessor">#if defined (CY_IP_MXS40SSRSS) || (defined (CY_IP_MXS40SRSS) &amp;&amp; (CY_IP_MXS40SRSS_VERSION &gt;= 2) &amp;&amp; (defined (SRSS_BACKUP_VBCK_PRESENT) &amp;&amp; (SRSS_BACKUP_VBCK_PRESENT == 1u)))</span></div><div class="line">    <a class="code" href="group__group__syspm__data__enumerates.html#ga07d01979fa53fd8a53203bf362a8add1">cy_en_syspm_vddbackup_control_t</a> <a class="code" href="group__group__ipc__bt__data__structures.html#ga37e90f5e3bd99fac2021fb3a326607d4">mode</a> = <a class="code" href="group__group__syspm__functions__backup.html#ga9056ecea6aa1b86d3c657bd1692a92a8">Cy_SysPm_BackupGetSupply</a>();</div><div class="line">    (void) mode;</div><div class="line"><span class="preprocessor">#endif </span><span class="comment">/* defined (CY_IP_MXS40SSRSS) || (defined (CY_IP_MXS40SRSS) &amp;&amp; (CY_IP_MXS40SRSS_VERSION &gt;= 2) &amp;&amp; (defined (SRSS_BACKUP_VBCK_PRESENT) &amp;&amp; (SRSS_BACKUP_VBCK_PRESENT == 1u))) */</span><span class="preprocessor"></span></div></div><!-- fragment --></dd></dl>

</div>
</div>
<a id="gad87323df5ca65d861bcb67b03c7ee594"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad87323df5ca65d861bcb67b03c7ee594">&#9670;&nbsp;</a></span>Cy_SysPm_BackupEnableVoltageMeasurement()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysPm_BackupEnableVoltageMeasurement </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function enables Vbackup supply measurement by the ADC. </p>
<p>The function connects the Vbackup supply to AMuxBusA. The ADC input can then be connected to AMuxBusA. Note that the measured signal is scaled by 10% to allow full range measurement by the ADC.</p>
<p>Refer to device TRM for more detail about backup supply modes. Will do nothing if device TRM denotes VBACKUP_MEAS register field is unavailable.</p>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: There is a need to enable Vbackup supply measurement</span></div><div class="line"><span class="comment">    * via AMuxBusA, e.g. by the internal ADC.  </span></div><div class="line"><span class="comment">    */</span></div><div class="line">    <span class="comment">/* Connect amuxbus_sar to amuxbus_main */</span></div><div class="line">    HSIOM-&gt;AMUX_SPLIT_CTL[6] = HSIOM_AMUX_SPLIT_CTL_SWITCH_AA_SL_Msk | HSIOM_AMUX_SPLIT_CTL_SWITCH_AA_SR_Msk;</div><div class="line"></div><div class="line">    <span class="comment">/* Connect amuxbus_adft0_vddd to amuxbus_main */</span></div><div class="line">    HSIOM-&gt;AMUX_SPLIT_CTL[0] = HSIOM_AMUX_SPLIT_CTL_SWITCH_AA_SL_Msk | HSIOM_AMUX_SPLIT_CTL_SWITCH_AA_SR_Msk;</div><div class="line"></div><div class="line">    <span class="comment">/* Connect Vddbackmeasure to AMuxBus */</span></div><div class="line"><span class="preprocessor">#if defined (CY_IP_MXS40SSRSS) || (defined (CY_IP_MXS40SRSS) &amp;&amp; (CY_IP_MXS40SRSS_VERSION &gt;= 2) &amp;&amp; (defined (SRSS_BACKUP_VBCK_PRESENT) &amp;&amp; (SRSS_BACKUP_VBCK_PRESENT == 1u)))</span></div><div class="line">    <a class="code" href="group__group__syspm__functions__backup.html#gad87323df5ca65d861bcb67b03c7ee594">Cy_SysPm_BackupEnableVoltageMeasurement</a>();</div><div class="line"><span class="preprocessor">#endif </span><span class="comment">/* defined (CY_IP_MXS40SSRSS) || (defined (CY_IP_MXS40SRSS) &amp;&amp; (CY_IP_MXS40SRSS_VERSION &gt;= 2) &amp;&amp; (defined (SRSS_BACKUP_VBCK_PRESENT) &amp;&amp; (SRSS_BACKUP_VBCK_PRESENT == 1u))) */</span><span class="preprocessor"></span></div></div><!-- fragment --></dd></dl>

</div>
</div>
<a id="ga2de08a3d7db223f4106d938843f5b846"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2de08a3d7db223f4106d938843f5b846">&#9670;&nbsp;</a></span>Cy_SysPm_BackupDisableVoltageMeasurement()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysPm_BackupDisableVoltageMeasurement </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The function disables Vbackup supply measurement by the ADC by disconnecting the Vbackup supply from AMuxBusA. </p>
<p>Refer to device TRM for more detail about backup supply modes. Will do nothing if device TRM denotes VBACKUP_MEAS register field is unavailable.</p>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: There is a need to disable the Vbackup supply measurement by the ADC */</span></div><div class="line"><span class="preprocessor">#if defined (CY_IP_MXS40SSRSS) || (defined (CY_IP_MXS40SRSS) &amp;&amp; (CY_IP_MXS40SRSS_VERSION &gt;= 2) &amp;&amp; (defined (SRSS_BACKUP_VBCK_PRESENT) &amp;&amp; (SRSS_BACKUP_VBCK_PRESENT == 1u)))</span></div><div class="line">    <a class="code" href="group__group__syspm__functions__backup.html#ga2de08a3d7db223f4106d938843f5b846">Cy_SysPm_BackupDisableVoltageMeasurement</a>();</div><div class="line"><span class="preprocessor">#endif </span><span class="comment">/* defined (CY_IP_MXS40SSRSS) || (defined (CY_IP_MXS40SRSS) &amp;&amp; (CY_IP_MXS40SRSS_VERSION &gt;= 2) &amp;&amp; (defined (SRSS_BACKUP_VBCK_PRESENT) &amp;&amp; (SRSS_BACKUP_VBCK_PRESENT == 1u))) */</span><span class="preprocessor"></span></div></div><!-- fragment --></dd></dl>

</div>
</div>
<a id="ga8ec1e64a405842b4b5bd62a418dfad1f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8ec1e64a405842b4b5bd62a418dfad1f">&#9670;&nbsp;</a></span>Cy_SysPm_BackupSuperCapCharge()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysPm_BackupSuperCapCharge </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__syspm__data__enumerates.html#gaffbcaa784d215b003d6b95e0620b9fa7">cy_en_syspm_sc_charge_key_t</a>&#160;</td>
          <td class="paramname"><em>key</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Configures the supercapacitor charger circuit. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">key</td><td>Passes the key to enable or disable the supercapacitor charger circuit. See <a class="el" href="group__group__syspm__data__enumerates.html#gaffbcaa784d215b003d6b95e0620b9fa7">cy_en_syspm_sc_charge_key_t</a>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section warning"><dt>Warning</dt><dd>This function is used only for charging the supercapacitor. Do not use this function to charge a battery. Refer to device TRM for more detail about backup supply modes. Will do nothing if device TRM denotes EN_CHARGE_KEY register field is unavailable.</dd></dl>
<dl class="section user"><dt>Function Usage</dt><dd><div class="fragment"><div class="line">    <span class="comment">/* Scenario: There is a need to charge the supercapacitor which will</span></div><div class="line"><span class="comment">     * supply the RTC during Hibernate mode for a few hours</span></div><div class="line"><span class="comment">     */</span></div><div class="line"><span class="preprocessor">#if defined (CY_IP_MXS40SSRSS) || (defined (CY_IP_MXS40SRSS) &amp;&amp; (CY_IP_MXS40SRSS_VERSION &gt;= 2) &amp;&amp; (defined (SRSS_BACKUP_VBCK_PRESENT) &amp;&amp; (SRSS_BACKUP_VBCK_PRESENT == 1u)))</span></div><div class="line">    <a class="code" href="group__group__syspm__functions__backup.html#ga8ec1e64a405842b4b5bd62a418dfad1f">Cy_SysPm_BackupSuperCapCharge</a>(<a class="code" href="group__group__syspm__data__enumerates.html#ggaffbcaa784d215b003d6b95e0620b9fa7ad9281b6f6744e83f380cd0b0c7f2821c">CY_SYSPM_SC_CHARGE_ENABLE</a>);</div><div class="line"><span class="preprocessor">#endif </span><span class="comment">/* defined (CY_IP_MXS40SSRSS) || (defined (CY_IP_MXS40SRSS) &amp;&amp; (CY_IP_MXS40SRSS_VERSION &gt;= 2) &amp;&amp; (defined (SRSS_BACKUP_VBCK_PRESENT) &amp;&amp; (SRSS_BACKUP_VBCK_PRESENT == 1u))) */</span><span class="preprocessor"></span></div></div><!-- fragment --></dd></dl>

</div>
</div>
<a id="gaaad0d60d7cd653e0651f6eb4e66ab02f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaaad0d60d7cd653e0651f6eb4e66ab02f">&#9670;&nbsp;</a></span>Cy_SysPm_BackupWordStore()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysPm_BackupWordStore </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>wordIndex</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t *&#160;</td>
          <td class="paramname"><em>wordSrcPointer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>wordSize</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Stores supported number of words(SRSS_BACKUP_NUM_BREG) in Backup Domain. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">wordIndex</td><td>Offset/Index of Backup Register Region(BREG) to where the data needs to be stored. Starts with 0, ends with (SRSS_BACKUP_NUM_BREG - 1)</td></tr>
    <tr><td class="paramname">wordSrcPointer</td><td>Source address from where the words have to be picked and backed up.</td></tr>
    <tr><td class="paramname">wordSize</td><td>Number of words to be stored</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A (TVIIBE only), CAT1B and CAT1C devices. </dd></dl>

</div>
</div>
<a id="gad101a96506a0ea0ef62f2a09af94be55"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad101a96506a0ea0ef62f2a09af94be55">&#9670;&nbsp;</a></span>Cy_SysPm_BackupWordReStore()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Cy_SysPm_BackupWordReStore </td>
          <td>(</td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>wordIndex</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t *&#160;</td>
          <td class="paramname"><em>wordDstPointer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>wordSize</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Restores supported number of words(SRSS_BACKUP_NUM_BREG) in Backup Domain. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">wordIndex</td><td>Offset/Index of Backup Register Region(BREG) from where the data need to be Restored. Starts with 0, ends with (SRSS_BACKUP_NUM_BREG - 1)</td></tr>
    <tr><td class="paramname">wordDstPointer</td><td>Destination address from where the backed up words have to be written.</td></tr>
    <tr><td class="paramname">wordSize</td><td>Number of words to be Restored</td></tr>
  </table>
  </dd>
</dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1A (TVIIBE only), CAT1B and CAT1C devices. </dd></dl>

</div>
</div>
<a id="ga0d4a41fe70f20ca3ea7b2e78994004ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0d4a41fe70f20ca3ea7b2e78994004ae">&#9670;&nbsp;</a></span>Cy_SysPm_SetupDeepSleepRAM()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a> Cy_SysPm_SetupDeepSleepRAM </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__group__syspm__data__enumerates.html#gacf9bb0bb5be207ed5e2e87d6c41dbb40">cy_en_syspm_dsram_checks_t</a>&#160;</td>
          <td class="paramname"><em>dsramCheck</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t *&#160;</td>
          <td class="paramname"><em>dsramIntState</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Implements Pre and Post Deepsleep RAM Setup. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">dsramCheck</td><td>CY_SYSPM_PRE_DSRAM or CY_SYSPM_POST_DSRAM</td></tr>
    <tr><td class="paramname">dsramIntState</td><td>Variable to save the interrupt state before and after Deepsleep RAM.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>CY_SYSPM_SUCCESS - Deepsleep RAM checks are successful</li>
<li>CY_SYSPM_CANCELED - Operation was canceled. Call the function again until the function returns CY_SYSPM_SUCCESS.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1B devices. </dd></dl>

</div>
</div>
<a id="ga0ad6666907cdc8668196bc5e849cd7f1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0ad6666907cdc8668196bc5e849cd7f1">&#9670;&nbsp;</a></span>Cy_SysPm_CpuEnterRAMOffDeepSleep()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a> Cy_SysPm_CpuEnterRAMOffDeepSleep </td>
          <td>(</td>
          <td class="paramtype">void&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets executing CPU to the Deep Sleep mode forceful RAM OFF. </p>
<dl class="section return"><dt>Returns</dt><dd>Entered status, see <a class="el" href="group__group__syspm__data__enumerates.html#ga601b1cb722cb091133caf33d8ab235ca">cy_en_syspm_status_t</a>.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This API is available for CAT1B devices.</dd>
<dd>
This API is not a standard PDL interface, it is a custom defined Power Management State, not to be used by the customers. </dd></dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part
<div id="nav-path" class="navpath">
    <ul>
        <li class="footer">
            Generated for <b>MTB CAT1 Peripheral driver library</b> by <b>Cypress Semiconductor Corporation</b>.
            All rights reserved.
        </li>
    </ul>
</div>
-->
</body>
</html>
